<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>robotide.action.actioninfo</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="robotide-module.html">Package&nbsp;robotide</a> ::
        <a href="robotide.action-module.html">Package&nbsp;action</a> ::
        Module&nbsp;actioninfo
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module actioninfo</h1><p class="nomargin-top"><span class="codelink"><a href="robotide.action.actioninfo-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Classes</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.action.actioninfo.MenuInfo-class.html" class="summary-name">MenuInfo</a><br />
      Base class for <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a> and <a href="robotide.action.actioninfo.SeparatorInfo-class.html" class="link">SeparatorInfo</a>.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.action.actioninfo.ActionInfo-class.html" class="summary-name">ActionInfo</a><br />
      Used to create menu entries, keyboard shortcuts and/or toolbar buttons.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.action.actioninfo.SeparatorInfo-class.html" class="summary-name">SeparatorInfo</a><br />
      Used to create separators to menus.
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.action.actioninfo-module.html#ActionInfoCollection" class="summary-sig-name">ActionInfoCollection</a>(<span class="summary-sig-arg">data</span>,
        <span class="summary-sig-arg">event_handler</span>,
        <span class="summary-sig-arg">container</span>=<span class="summary-sig-default">None</span>)</span><br />
      Parses the <tt class="rst-docutils literal">data</tt> into a list of <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a> and <a href="robotide.action.actioninfo.SeparatorInfo-class.html" class="link">SeparatorInfo</a> objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#ActionInfoCollection">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="robotide.action.actioninfo-module.html#__package__" class="summary-name">__package__</a> = <code title="'robotide.action'"><code class="variable-quote">'</code><code class="variable-string">robotide.action</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<p class="indent-wrapped-lines"><b>Imports:</b>
  <span title="wx">wx</span>,
  <span title="re">re</span>,
  <a href="robotide.action.shortcut.Shortcut-class.html" title="robotide.action.shortcut.Shortcut">Shortcut</a>
</p><br />
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="ActionInfoCollection"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ActionInfoCollection</span>(<span class="sig-arg">data</span>,
        <span class="sig-arg">event_handler</span>,
        <span class="sig-arg">container</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#ActionInfoCollection">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Parses the <tt class="rst-rst-docutils literal rst-docutils literal">data</tt> into a list of <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a> and <a href="robotide.action.actioninfo.SeparatorInfo-class.html" class="link">SeparatorInfo</a> objects.</p>
<p>The data is parsed based on the simple DSL documented below.</p>
<div class="rst-section" id="rst-dsl-syntax">
<h1 class="heading">DSL syntax</h1>
<pre class="rst-literal-block">
[menu]
name | documentation | shortcut | icon
</pre>
</div>
<div class="rst-section" id="rst-fields">
<h1 class="heading">Fields</h1>
<dl class="rst-docutils">
<dt>menu</dt>
<dd>The name of the menu under which the entries below it are inserted.</dd>
<dt>name</dt>
<dd>The name of the menu entry to be added. If name is <tt class="rst-docutils literal"><span class="pre">---</span></tt>, a
<a href="robotide.action.actioninfo.SeparatorInfo-class.html" class="link">SeparatorInfo</a> object is created instead of an <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a> object.
If name is post fixed with shortcuts between parenthesis and separated
with ' or ', these shortcuts are parsed to machine local presentation
and shown after the name. This can be used instead of shotrcut-element
if you want to add shortcuts that you want to bind yourself and/or add
several shortcuts.</dd>
<dt>documentation</dt>
<dd>Documentation for the action.</dd>
<dt>shortcut</dt>
<dd>Keyboard shortcut to invoke the action.</dd>
<dt>icon</dt>
<dd>Icon for the toolbar button.</dd>
</dl>
<p>See the <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a> attributes with same/similar names for more
information about the fields and their possible values. Three
last fields are optional.</p>
</div>
<div class="rst-section" id="rst-finding-handlers">
<h1 class="heading">Finding handlers</h1>
<p>The given <tt class="rst-docutils literal">event_handler</tt> must have handler methods that map to the
specified action names. The mapping is done by prefixing the name with
<tt class="rst-docutils literal">On</tt>, removing spaces, and capitalizing all words. For example <tt class="rst-docutils literal">Save</tt>
and <tt class="rst-docutils literal">My Action</tt> must have handler methods <tt class="rst-docutils literal">OnSave</tt> and <tt class="rst-docutils literal">OnMyAction</tt>,
respectively. If name has content between parenthesis at the end, this
content is ignored when creating handler mapping.</p>
</div>
<div class="rst-section" id="rst-specifying-container">
<h1 class="heading">Specifying container</h1>
<p>By default the given <tt class="rst-docutils literal">container</tt> is passed to the <a href="robotide.action.actioninfo.ActionInfo-class.html#__init__" class="link">ActionInfo.__init__</a>
method directly. This can be altered by prefixing the <tt class="rst-docutils literal">name</tt> with an
exclamation mark (e.g. <tt class="rst-docutils literal">!Save</tt> or <tt class="rst-docutils literal">!My Action</tt>) to make that action
global. With these actions the container given to the <a href="robotide.action.actioninfo.ActionInfo-class.html#__init__" class="link">ActionInfo.__init__</a>
is always <tt class="rst-docutils literal">None</tt>.</p>
</div>
<div class="rst-section" id="rst-example">
<h1 class="heading">Example</h1>
<pre class="rst-literal-block">
[File]
!&amp;Open | Open file containing tests | Ctrl-O | ART_FILE_OPEN
!Open &amp;Resource | Open a resource file | Ctrl-R
---
&amp;Save | Save selected datafile | Ctrl-S | ART_FILE_SAVE

[Tools]
!Manage Plugins

[Content]
Content Assist (Ctrl-Space or Ctrl-Alt-Space) | Has two shortcuts.
</pre>
</div>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>data</code></strong> - The data to be parsed into <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a> and <a href="robotide.action.actioninfo.SeparatorInfo-class.html" class="link">SeparatorInfo</a> objects.</li>
        <li><strong class="pname"><code>event_handler</code></strong> - The event handler that implements the actions. See <a class="rst-reference internal" href="#rst-finding-handlers">finding handlers</a>
for more information.</li>
        <li><strong class="pname"><code>container</code></strong> - the wxPython element containing the UI components associated with
the <a href="robotide.action.actioninfo.ActionInfo-class.html" class="link">ActionInfo</a>.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables Details</span></td>
</tr>
</table>
<a name="__package__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">__package__</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">robotide.action</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Apr 13 15:09:36 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
